//---------------------------------------------------------------------------------
// Copyright (c) 2008 VoiceLynx Project
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
//     1. The origin of this software must not be misrepresented; you must not
//        claim that you wrote the original software. If you use this software
//        in a product, an acknowledgment in the product documentation would be
//        appreciated but is not required.
//
//     2. Altered source versions must be plainly marked as such, and must not be
//        misrepresented as being the original software.
//
//     3. This notice may not be removed or altered from any source
//        distribution.
//---------------------------------------------------------------------------------

#ifndef __VLSound_h__
#define __VLSound_h__

#include "VLPrerequisites.h"

#include "VLCodec.h"

class VLIStaticSound
{
public:
  virtual ~VLIStaticSound() { }

  virtual void play() = 0;
};

typedef std::auto_ptr<VLIStaticSound> VLStaticSoundPtr;

class VLISoundStreamPlayer
{
public:
  virtual ~VLISoundStreamPlayer() { }

  virtual void giveData(VLByteArrayPtr data) = 0;
};

typedef std::auto_ptr<VLISoundStreamPlayer> VLSoundStreamPlayerPtr;

class VLISoundManager
{
public:
  virtual ~VLISoundManager() { }

  virtual VLStaticSoundPtr createStaticSound(const VLString &source) = 0;
  virtual VLSoundStreamPlayerPtr createSoundStreamPlayer(VLDecoderPtr decoder) = 0;

  //virtual void setEncoder(VLEncoderPtr encoder) = 0;
  virtual void clearCapturedSoundData() = 0;
  virtual VLByteArrayPtr takeCapturedSoundData() = 0;

  virtual float getTxVolume() = 0;

  virtual void process() = 0;
};

typedef std::auto_ptr<VLISoundManager> VLSoundManagerPtr;


#endif